<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Abstract ScalarParameter Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">AbstractScalarParameter Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Represents the abstract scalar parameter types.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Abstract ScalarParameter</td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>XML Element:</td>
<td><code>None</code></td></tr>
<tr><td>Extends:</td>
<td><a href="Parameter.html">Parameter</a></td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>Yes</td></tr>
<tr><td>Name Space:</td>
<td>Parameters</td></tr>
<tr><td>Name Requirement:</td>
<td>Optional</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-dataSetName">dataSetName</a></dt>
<dd>Refer to a data set for the dynamic selection list.</dd>
<dt><a href="#Property-dataType">dataType</a></dt>
<dd>The data type for the parameter.</dd>
<dt><a href="#Property-defaultValue">defaultValue</a></dt>
<dd>The default value of the parameter.</dd>
<dt><a href="#Property-distinct">distinct</a></dt>
<dd></dd>
<dt><a href="#Property-isRequired">isRequired</a></dt>
<dd>The flag that indicates whether the value of the parameter is required.</dd>
<dt><a href="#Property-labelExpr">labelExpr</a></dt>
<dd>The prompt for the dynamic choices.</dd>
<dt><a href="#Property-listLimit">listLimit</a></dt>
<dd>List limitation number.</dd>
<dt><a href="#Property-selectionList">selectionList</a></dt>
<dd>Defines a selection list for the parameter: static 
list of values from which the user can choose.</dd>
<dt><a href="#Property-sortBy">sortBy</a></dt>
<dd>The sort key for parameter values when preview.</dd>
<dt><a href="#Property-sortByColumn">sortByColumn</a></dt>
<dd>The expression by which the result sorts.</dd>
<dt><a href="#Property-sortDirection">sortDirection</a></dt>
<dd>The sort order for parameter values when preview.</dd>
<dt><a href="#Property-valueExpr">valueExpr</a></dt>
<dd>The expression to get the value for the choice.</dd>
<dt><a href="#Property-valueType">valueType</a></dt>
<dd>The parameter type for this scalar parameter.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="Parameter.html#Property-helpText">helpText</a>, 
<a href="Parameter.html#Property-helpTextID">helpTextID</a>, 
<a href="Parameter.html#Property-hidden">hidden</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="Parameter.html#Property-promptText">promptText</a>, 
<a href="Parameter.html#Property-promptTextID">promptTextID</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Inherited Methods</h3>

<p class="section-text">
<a href="Parameter.html#Method-validate">validate</a></p>
<h3>Description</h3>

<div class="section-text">
<p>Represents the abstract scalar parameter types, which defines a single-value parameter. </p>

<p>Abstract scalar parameters can provide a selection list. The list 
can be static (defined by the <code>selectionList</code> 
property) or dynamic (defined by the <code>dataSet</code>,
<code>valueExpr</code> and <code>labelExpr</code> 
properties.)  The user can sort this list by specified key and direction(as controlled by the <code>
sortDirection</code>, <code>sortBy</code> and <code>sortByColumn</code> properties).</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-dataSetName">dataSetName Property</a></h2>

<p class="section-text">Refer to a data set for the dynamic selection list.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/DataSet.html">DataSet</a> Reference</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>DataSet Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Dynamic list</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Refer to a data set for the selection list. Once this property is set, the selection list is dynamic.</p></div>

<hr>
<h2><a name="Property-dataType">dataType Property</a></h2>

<p class="section-text">The data type for the parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (paramType)</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Data type</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>string</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>string</td>
<td>String</td>
<td>string</td>
<td></td></tr>
<tr><td>float</td>
<td>Float</td>
<td>float</td>
<td></td></tr>
<tr><td>decimal</td>
<td>Decimal</td>
<td>decimal</td>
<td></td></tr>
<tr><td>dateTime</td>
<td>Date Time</td>
<td>dateTime</td>
<td></td></tr>
<tr><td>boolean</td>
<td>Boolean</td>
<td>boolean</td>
<td></td></tr>
<tr><td>integer</td>
<td>Integer</td>
<td>integer</td>
<td></td></tr>
<tr><td>date</td>
<td>Date</td>
<td>date</td>
<td></td></tr>
<tr><td>time</td>
<td>Time</td>
<td>time</td>
<td></td></tr>
<tr><td>javaObject</td>
<td>Java Object</td>
<td>javaObject</td>
<td></td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The data type for the parameter. The data type controls 
how the Requester formats, parses and validates the parameter. Every type can optionally provide a choice list. 
And, the parameter can require that the user select one of the choices.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>selectionList</code> property</p>
<p><code>defaultValue</code> property</p></div>

<hr>
<h2><a name="Property-defaultValue">defaultValue Property</a></h2>

<p class="section-text">The default value of the parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#list">list</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Default value</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The default value for the parameter. The default value 
can be an expression, but cannot reference any other parameters.</p></div>

<hr>
<h2><a name="Property-distinct">distinct Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Distinct</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>true</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-isRequired">isRequired Property</a></h2>

<p class="section-text">The flag that indicates whether the value of the parameter is required.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Is required</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>true</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The flag indicates whether the value of the parameter is required.
<code>true</code> if the value of the parameter is required.
For string type parameter, if the value is required, it cannot be <code>null</code> or empty.
For other type parameters, required value cannot be <code>null</code>.
</p></div>

<hr>
<h2><a name="Property-labelExpr">labelExpr Property</a></h2>

<p class="section-text">The prompt for the dynamic choices.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>string</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Label expression</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Dynamic list</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>An expression that returns the display value for each row in the dynamic list.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>valueExpr</code> property</p></div>

<hr>
<h2><a name="Property-listLimit">listLimit Property</a></h2>

<p class="section-text">List limitation number.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>List limit</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Value for the list limitation number. If the limitation is provided, only the top-n choices will 
be available in the parameter request dialog.</p></div>

<hr>
<h2><a name="Property-selectionList">selectionList Property</a></h2>

<p class="section-text">Defines a selection list for the parameter: static 
list of values from which the user can choose.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/SelectionChoice.html">SelectionChoice</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Selection list</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The parameter selection list provides a developer-defined list of choices. 
Every choice has two parts: a choice and a label. The label can be externalized 
and appears in the UI. The choice is the value passed to the report. For 
example, labels may be "Open" and "Closed", while the values are 0 and 1.</p>
<p>The items in the list are of the type given by the parameter data type.</p></div>

<hr>
<h2><a name="Property-sortBy">sortBy Property</a></h2>

<p class="section-text">The sort key for parameter values when preview.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (paramSortValues)</td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Sort by</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>value</td>
<td>Value</td>
<td>value</td>
<td></td></tr>
<tr><td>label</td>
<td>Display Text</td>
<td>label</td>
<td></td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The sort key for parameter values when preview.Its value can be <i>label</i> or <i>value</i>.</p></div>

<hr>
<h2><a name="Property-sortByColumn">sortByColumn Property</a></h2>

<p class="section-text">The expression by which the result sorts.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>None</td></tr>
<tr><td>Since:</td>
<td>2.3</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Sort by column</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The expression by which the result sorts.</p></div>

<hr>
<h2><a name="Property-sortDirection">sortDirection Property</a></h2>

<p class="section-text">The sort order for parameter values when preview.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (sortDirection)</td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Sort direction</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>asc</td>
<td>Ascending</td>
<td>asc</td>
<td></td></tr>
<tr><td>desc</td>
<td>Descending</td>
<td>desc</td>
<td></td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The sort order for parameter values when preview. Its value can be <i>asc</i> or <i>desc</i>.</p></div>

<hr>
<h2><a name="Property-valueExpr">valueExpr Property</a></h2>

<p class="section-text">The expression to get the value for the choice.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#expression">expression</a></td></tr>
<tr><td>Context:</td>
<td></td></tr>
<tr><td>Expression Type:</td>
<td>any</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Value expression</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Dynamic list</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The expression on the data row from the dynamic list data set that
 returns the value for the choice.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>lableExpr</code> property</p></div>

<hr>
<h2><a name="Property-valueType">valueType Property</a></h2>

<p class="section-text">The parameter type for this scalar parameter.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (paramValueType)</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Value type</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>static</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>static</td>
<td>Static</td>
<td>static</td>
<td></td></tr>
<tr><td>dynamic</td>
<td>Dynamic</td>
<td>dynamic</td>
<td></td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The parameter type for this scalar parameter. Its value can be <i>dynamic</i> or <i>static</i>.</p>

<p>&nbsp;</p></div>
</body>
</html>
